home *** CD-ROM | disk | FTP | other *** search
/ Win Platinum / Win Platinum.iso / apps / projclk / projclk.doc next >
Encoding:
Text File  |  1991-03-20  |  5.2 KB  |  146 lines
  1.               PROJECT CLOCK
  2.  
  3. INTRODUCTION
  4. Project Clock allows the user to monitor and optionally record
  5. his/her time usage on various projects. Running unobtrusively
  6. as a digital clock icon, Project Clock shows elapsed time 
  7. rather than wallclock time. The user stops and starts 
  8. Project Clock through its system menu. The user may accumulate 
  9. a project log file with optional comments. 
  10.  
  11. USING PROJECT CLOCK
  12. Start project clock like any other Windows application by 
  13. any of the following methods: clicking on it, associating it 
  14. with a log file and clicking on the log file, placing it in 
  15. the Load line of your WIN.INI file, or adding it to a Program
  16. Manager group. Project Clock only runs as an icon.
  17.  
  18. USING PROJECT CLOCK WITH A LOG FILE
  19. Passing a file name on its command line directs Project 
  20. Clock to use that file as a log. On exiting or restarting, 
  21. Project Clock appends a line to the log file containing 
  22. these four fields:
  23.    1) the date Project Clock was started,
  24.    2) the time Project Clock was started,
  25.    3) the elapsed time that Project Clock ran, and
  26.    4) an optional comment, entered by the user.
  27.  
  28. The log file is a simple text file which may be edited
  29. using any common editor. The four fields are separated
  30. by tab characters for easy import into a spreadsheet.
  31. The date and time formats are set by the International options
  32. chosen under Windows Control Panel.
  33.  
  34. INCREMENTAL LOG FILE
  35. Project Clock protects its accumulated value against crashes
  36. by periodically saving the elapsed time into a separate 
  37. incremental log file. When Project Clock starts up, it checks
  38. for an incremental log file left over from previous session
  39. which ended abruptly. On finding a leftover file, Project Clock 
  40. displays a dialog box asking the user if Project Clock should
  41. update the main log with the contents of the incremental 
  42. log file. Typically the user selects Yes.
  43.  
  44. Project Clock automatically generates incremental log files.
  45. An incremental log file name resembles the user-specified 
  46. log file name except that an incremental log file takes 
  47. the suffix .ILF .
  48.  
  49. SYSTEM MENU
  50. Besides the standard Windows menu items, Project Clock's
  51. System Menu adds these special items:
  52.  
  53. Start Clock! resumes the clock, turning its frame and numerals
  54. light green. 
  55.  
  56. Stop Clock! suspends the clock, turning its frame and numerals red. 
  57.  
  58. Options... displays the Project Clock Options Dialog Box, 
  59. discussed below.
  60.  
  61. Edit/view Log File spawns the user's chosen editor or browser,
  62. allowing the user to edit or view the log file. 
  63. The user may safely edit the log while Project Clock 
  64. is running since Project Clock only updates the log at the 
  65. beginning or end of a session. The current elapsed time
  66. will not yet appear in the log file.
  67.  
  68. Close without Logging Comment exits Project Clock.
  69. If a log file is used, Project Clock first saves the elapsed time.
  70.  
  71. Restart without Logging Comment restarts Project Clock's timer. 
  72. If a log file is used, Project Clock first saves the elapsed time.
  73.  
  74. Log Comment and Close exits Project Clock.
  75. If a log file is used, Project Clock prompts the user for an 
  76. ending comment, updates the log file with the elapsed time, 
  77. then exits.
  78.  
  79. Log Comment and Restart restarts Project Clock's timer.
  80. If a log file is used, Project Clock prompts the user for a comment, 
  81. updates the log file with the elapsed time, then restarts the timer.
  82.  
  83. PROJECT CLOCK OPTIONS
  84. Project Clock's Options menu has the following entries:
  85.  
  86. Clock Format formats both the displayed time and logged time 
  87. in either hours and minutes, hours and tenths, or
  88. hours and hundredths. 
  89.  
  90. Initial State allows the clock to be either on
  91. or off when Project Clock starts up.
  92.  
  93. Autosave Interval dictates how frequently Project Clock
  94. automatically saves the incremental log file. (The user may 
  95. notice occasional disk activity as Project Clock saves 
  96. this file.) If Never is selected, Project Clock saves 
  97. the incremental value only when the user suspends the clock. 
  98.  
  99. Prompt for Comment on Exit specifies whether or not 
  100. Project Clock prompts for a comment  when the user
  101. shuts down Windows.
  102.  
  103. Default Log File specifies which log file to use if one
  104. is not specified on the command line. A default log file
  105. is not required for Project Clock to operate. The
  106. default file name should not be given the suffix .ILF.
  107.  
  108. Editor/browser is the name of a program that Project Clock
  109. should spawn to edit or view the log. Notepad is the default.
  110. Note that the interval Project Clock is currently 
  111. displaying does not yet appear in the log.
  112.  
  113. The Save button writes the current Options menu settings
  114. to the WIN.INI file.
  115.  
  116. The Cancel button discards any values the user may have
  117. entered.
  118.  
  119. WINDOWS RELEASES SUPPORTED
  120. Project Clock runs under Windows 3.0 in real, standard, 
  121. and 386 enhanced modes.
  122.  
  123. LIMITATIONS
  124. Project Clock restarts on rolling over at 100 hours.
  125.  
  126. LEGAL
  127. Project Clock's users take all responsibility for using it.
  128.  
  129. TRADEMARKS
  130. 386 -- Intel Corp.
  131. Windows -- Microsoft Corp.
  132.  
  133. DISTRIBUTION
  134. Please don't hesitate to distribute Project Clock 
  135. to anyone who would like to try it. 
  136.  
  137. THE PITCH
  138. If you find Project Clock useful, please send a 
  139. contribution of $7.00 to:
  140.  
  141.     Robert A. Heath
  142.     157 Chartwell Rd.
  143.     Columbia, SC 29210
  144.  
  145. Copyright 1991 Robert A. Heath 
  146.